home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / misc / cyberdev.lha / developer / autodoc / cybergraphics.doc < prev   
Encoding:
Text File  |  1995-01-10  |  23.3 KB  |  763 lines
  1. TABLE OF CONTENTS
  2.  
  3. cybergraphics.library/AllocCModeListTagList
  4. cybergraphics.library/BestCModeIDTagList
  5. cybergraphics.library/CModeRequestTagList
  6. cybergraphics.library/DoCDrawMethodTagList
  7. cybergraphics.library/FillPixelArray
  8. cybergraphics.library/FreeCModeList
  9. cybergraphics.library/GetCyberMapAttr
  10. cybergraphics.library/GetCyberIDAttr
  11. cybergraphics.library/IsCyberModeID
  12. cybergraphics.library/MovePixelArray
  13. cybergraphics.library/ReadPixelArray
  14. cybergraphics.library/ReadRGBPixel
  15. cybergraphics.library/SwapPixelArray
  16. cybergraphics.library/WritePixelArray
  17. cybergraphics.library/WriteRGBPixel
  18. cybergraphics.lib/AllocCModeListTagList cybergraphics.lib/AllocCModeListTagList
  19.  
  20.  
  21.    NAME
  22.     AllocCModeListTagList -- get an exec list with requested modes.
  23.  
  24.    SYNOPSIS
  25.     result = CModeRequestTagList(ModeListTags);
  26.     D0                                A1
  27.  
  28.     APTR AllocCModeListTagList(struct TagItem *);
  29.  
  30.    FUNCTION
  31.     Allocates a list structure which contains all requested modes (All nodes
  32.     are of type CyberModeNode). See defines for more information about the
  33.     structure of this nodes.
  34.  
  35.    INPUTS
  36.     tags - pointer to an optional tag list which may be used to
  37.            control the number of returned modes.
  38.  
  39.    TAGS
  40.  
  41.     Tags available are:
  42.  
  43.     CYBRMREQ_MinWidth (ULONG) - The minimum display width to let the user
  44.             choose. Default is 320.
  45.  
  46.     CYBRMREQ_MaxWidth (ULONG) - The maximum display width to let the user
  47.             choose. Default is 1600.
  48.  
  49.     CYBRMREQ_MinHeight (ULONG) - The minimum display height to let the user
  50.             choose. Default is 240.
  51.  
  52.     CYBRMREQ_MaxHeight (ULONG) - The maximum display height to let the user
  53.             choose. Default is 1200.
  54.  
  55.     CYBRMREQ_MinDepth (UWORD) - The minimum display depth to let the user
  56.             choose. Default is 8.
  57.  
  58.     CYBRMREQ_MaxDepth (UWORD) - The maximum display depth to let the user
  59.             choose. Default is 32.
  60.  
  61.     CYBRMREQ_CModelArray (UWORD *) - Array of color models which should be
  62.             available for screenmode selection. Currently supported
  63.             colormodels are:
  64.  
  65.             PIXFMT_LUT8
  66.             PIXFMT_RGB15
  67.             PIXFMT_BGR15
  68.             PIXFMT_RGB15PC
  69.             PIXFMT_BGR15PC
  70.             PIXFMT_RGB16
  71.             PIXFMT_BGR16
  72.             PIXFMT_RGB16PC
  73.             PIXFMT_BGR16PC
  74.             PIXFMT_RGB24
  75.             PIXFMT_BGR24
  76.             PIXFMT_ARGB32
  77.             PIXFMT_BGRA32
  78.  
  79.             default is all colormodels available, nothing filtered
  80.  
  81.    RESULT
  82.     result - 0 if no modes are available, a pointer to a exec list if there
  83.          are modes which fit your needs.
  84. cybergraphics.library/BestCyberModeID   cybergraphics.library/BestCyberModeID
  85.  
  86.  
  87.    NAME
  88.     BestCModeIDTagList  -- calculate the best ModeID with given parameters
  89.  
  90.    SYNOPSIS
  91.     ID = BestCModeIDTagList(TagItems)
  92.     d0                     a0
  93.  
  94.     ID = BestCModeIDTagList(Tag1, ...)
  95.  
  96.    FUNCTION
  97.     To determine the best cybergraphics ModeID to fit the parameters set
  98.     in the TagList.
  99.  
  100.    INPUTS
  101.     TagItems - A pointer to an array of TagItems.
  102.  
  103.    TAGS
  104.  
  105.         CYBRBIDTG_Depth (ULONG) - depth the returned ModeID must support
  106.                                   Default is 8
  107.  
  108.         CYBRBIDTG_NominalWidth (UWORD),
  109.         CYBRBIDTAG_NominalHeight (UWORD) - desired width and height the ModeID
  110.                                            should have
  111.  
  112.         CYBRBIDTG_MonitorID (ULONG) - if multiple graphics boards are
  113.                                       installed in the system, you can choose
  114.                                       the desired one with this tag
  115.  
  116.    RESULT
  117.     ID      - ID of the best mode to use, or INVALID_ID if a match could
  118.               not be found.
  119.  
  120. cybergraphics.lib/CModeRequestTagList    cybergraphics.lib/CModeRequestTagList
  121.  
  122.  
  123.    NAME
  124.     CModeRequestTagList -- get screenmode from user using a requester.
  125.  
  126.    SYNOPSIS
  127.     result = CModeRequestTagList(requester,tags);
  128.     D0                            A0        A1
  129.  
  130.     LONG CModeRequestTagList(APTR,struct TagItem *);
  131.  
  132.    FUNCTION
  133.     Prompts the user for input by showing all available cybergraphics
  134.     screenmodes in a requester.
  135.     If the user cancels or the system aborts the request, FALSE is returned,
  136.     otherwise the displaymode id of the selected screenmode.
  137.  
  138.    INPUTS
  139.     requester - not used currently. you have to set it to 0 !
  140.     tags - pointer to an optional tag list which may be used to
  141.            control features of the requester.
  142.  
  143.    TAGS
  144.  
  145.     Tags used for the screen mode requester
  146.  
  147.     CYBRMREQ_Screen (struct Screen *) - Screen on which to open the requester.
  148.             default locale will be used.
  149.  
  150.     CYBRMREQ_WinTitle (STRPTR) - Title to use for the requesting window.
  151.  
  152.     CYBRMREQ_OKText (STRPTR) - Label of the positive gadget in the
  153.             requester. English default is "OK".
  154.  
  155.     CYBRMREQ_CancelText (STRPTR) - Label of the negative gadget in the
  156.             requester. English default is "Cancel".
  157.  
  158.     CYBRMREQ_MinWidth (ULONG) - The minimum display width to let the user
  159.             choose. Default is 320.
  160.  
  161.     CYBRMREQ_MaxWidth (ULONG) - The maximum display width to let the user
  162.             choose. Default is 1600.
  163.  
  164.     CYBRMREQ_MinHeight (ULONG) - The minimum display height to let the user
  165.             choose. Default is 240.
  166.  
  167.     CYBRMREQ_MaxHeight (ULONG) - The maximum display height to let the user
  168.             choose. Default is 1200.
  169.  
  170.     CYBRMREQ_MinDepth (UWORD) - The minimum display depth to let the user
  171.             choose. Default is 8.
  172.  
  173.     CYBRMREQ_MaxDepth (UWORD) - The maximum display depth to let the user
  174.             choose. Default is 32.
  175.  
  176.     CYBRMREQ_CModelArray (UWORD *) - Array of color models which should be
  177.             available for screenmode selection. Currently supported
  178.             colormodels are:
  179.  
  180.             PIXFMT_LUT8
  181.             PIXFMT_RGB15
  182.             PIXFMT_BGR15
  183.             PIXFMT_RGB15PC
  184.             PIXFMT_BGR15PC
  185.             PIXFMT_RGB16
  186.             PIXFMT_BGR16
  187.             PIXFMT_RGB16PC
  188.             PIXFMT_BGR16PC
  189.             PIXFMT_RGB24
  190.             PIXFMT_BGR24
  191.             PIXFMT_ARGB32
  192.             PIXFMT_BGRA32
  193.  
  194.             default is all colormodels available, nothing filtered
  195.  
  196.    RESULT
  197.     result - 0 if the user cancelled the requester or if something
  198.          prevented the requester from opening. If != 0 the displaymode
  199.          id of the selected screenmode is returned.
  200.  
  201.    BUGS
  202.     The requester structure is not supported in (v40)
  203. cybergraphics.lib/DoCDrawMethodTagList cybergraphics.lib/DoCDrawMethodTagList
  204.  
  205.  
  206.    NAME
  207.     DoCDrawMethodTagList - Do the given hook for the supplied rastport
  208.  
  209.    SYNOPSIS
  210.     DoCDrawMethodTagList(hook,rport,taglist)
  211.                           a0   a1    a2
  212.  
  213.     void DoCDrawMethodTagList(struct Hook *,struct RastPort *,
  214.                 struct TagItem *)
  215.  
  216.    FUNCTION
  217.     This function will call the given hook for the given rastport. Is is
  218.     mainly used to do direct bitmap modifications in a locked graphics
  219.     environment. You have to support ALL known color models, so only use
  220.     this call if you really need it !!
  221.     
  222.  
  223.    INPUTS
  224.  
  225.     hook - pointer to callback hook which will be called
  226.            with object == (struct RastPort *)
  227.            and message == [ (APTR) memptr,
  228.                             (ULONG) offsetx, (ULONG) offsety,
  229.                 (ULONG) xsize, (ULONG) ysize,
  230.                 (ULONG) bytesperrow, (UWORD) bytesperpix,
  231.                 (UWORD) colormodel]
  232.  
  233.            Where colormodel is one of the following:
  234.  
  235.             PIXFMT_LUT8
  236.             PIXFMT_RGB15
  237.             PIXFMT_BGR15
  238.             PIXFMT_RGB15PC
  239.             PIXFMT_BGR15PC
  240.             PIXFMT_RGB16
  241.             PIXFMT_BGR16
  242.             PIXFMT_RGB16PC
  243.             PIXFMT_BGR16PC
  244.             PIXFMT_RGB24
  245.             PIXFMT_BGR24
  246.             PIXFMT_ARGB32
  247.             PIXFMT_BGRA32
  248.  
  249.     rport- A pointer to a cybergraphics RastPort
  250.  
  251.     tags - optional taglist, currently not used. Set it to NULL
  252.  
  253.     NOTES
  254.     Use this call only if you want high speed. Remember that you have to
  255.     handle all color models ! Do not use ANY os functions in your hook.
  256.     They would cause unpredictable results.
  257.  
  258.  
  259.     BUGS
  260.     In the current release this function only works on screen rastports.
  261.     Because of this limitation clipping is not supported.
  262.  
  263.  
  264. cybergraphics.lib/FreeCModeList                cybergraphics.lib/FreeCModeList
  265.  
  266.  
  267.    NAME
  268.     FreeCModeList -- frees a previously allocated ModeList
  269.                          (AllocCModeListTagList)
  270.  
  271.    SYNOPSIS
  272.     FreeCModeList(ModeListTags);
  273.                       A0
  274.  
  275.     void FreeCModeList(struct List *);
  276.  
  277.    FUNCTION
  278.     Frees all data which was previously allocated by AllocCModeListTagList
  279.  
  280.    INPUTS
  281.     ModeListTags - a list structure which contains all the mode data.
  282.  
  283.    RESULT
  284.     none
  285.  
  286. cybergraphics.library/GetCyberMapAttr    cybergraphics.library/GetCyberMapAttr
  287.  
  288.  
  289.    NAME
  290.     GetCyberMapAttr -- Returns information about a cybergraphics bitmap
  291.  
  292.    SYNOPSIS
  293.      value=GetCyberMapAttr(bitmap,attribute_number);
  294.     d0                     a0       d1
  295.  
  296.     ULONG GetCyberMapAttr(struct BitMap *,ULONG);
  297.  
  298.    FUNCTION
  299.         Determines information about a extended cybergraphics bitmap.
  300.     This function should be used instead of making any assumptions about
  301.     fields in the bitmap. This will    provide future compatibility.
  302.  
  303.    INPUTS
  304.     bitmap - pointer to a cybergraphics bitmap structure
  305.  
  306.     attribute_number - A number telling cybergraphics which attribute
  307.                of the bitmap should be returned:
  308.  
  309.         CYBRMATTR_XMOD returns BytesPerRow of the supplied bitmap
  310.  
  311.         CYBRMATTR_BPPIX returns number of bytes per pixel
  312.  
  313.         CYBRMATTR_PIXFMT return the pixel format of the bitmap
  314.  
  315.         CYBRMATTR_WIDTH return width of the bitmap in pixels
  316.  
  317.         CYBRMATTR_HEIGHT return the height in lines
  318.  
  319.         CYBRMATTR_DEPTH returns bits per pixel
  320.  
  321.    BUGS
  322.  
  323.    NOTES
  324.  
  325.     Unknown attributes are reserved for future use, and return (-1L).
  326.  
  327.     You should know what you are doing if you call this function !
  328.     Don't apply it on a non cybergraphics bitmap !
  329.  
  330. cybergraphics.library/GetCyberIDAttr    cybergraphics.library/GetCyberIDAttr
  331.  
  332.  
  333.    NAME
  334.     GetCyberIDAttr -- Returns information about a cybergraphics id
  335.  
  336.    SYNOPSIS
  337.      value=GetCyberIDAttr(CyberIDAttr,CyberDisplayModeID);
  338.     d0                     d0           d1
  339.  
  340.     ULONG GetCyberIDAttr(ULONG,ULONG);
  341.  
  342.    FUNCTION
  343.         Determines information about a specified displaymode id.
  344.  
  345.    INPUTS
  346.     CyberDisplayModeID - cybergraphics mode id
  347.  
  348.     attribute_number - A number telling cybergraphics which attribute
  349.                of the displaymode id should be returned:
  350.  
  351.         CYBRIDATTR_PIXFMT return the pixel format of the supplied
  352.                 screenmode id
  353.  
  354.         CYBRIDATTR_WIDTH returns visible width in pixels
  355.         CYBRIDATTR_HEIGHT returns visible height in lines
  356.         CYBRIDATTR_DEPTH returns bits per pixel
  357.         CYBRIDATTR_BPPIX should return BytesPerPixel
  358.  
  359.    BUGS
  360.  
  361.    NOTES
  362.  
  363.     Unknown attributes are reserved for future use, and return (-1L).
  364.  
  365.     You should know what you are doing if you call this function !
  366.     Don't apply it on a non cybergraphics displaymode !
  367.  
  368.  
  369. cybergraphics.library/IsCyberModeID       cybergraphics.library/IsCyberModeID
  370.  
  371.  
  372.    NAME
  373.     IsCyberModeID -- returns whether supplied ModeID is a cybergraphics id
  374.  
  375.    SYNOPSIS
  376.     result = IsCyberModeID(modeID)
  377.     D0                       D0
  378.  
  379.     BOOL IsCyberModeID(ULONG)
  380.  
  381.    FUNCTION
  382.     Returns whether the supplied ModeID is a cybergraphics.library mode
  383.     identifier.
  384.  
  385.    INPUTS
  386.     modeID -- a 32 bit display identifier.
  387.  
  388.    RESULT
  389.     result - Flag to indicate if modeID is a cybergraphics ID
  390.  
  391. cybergraphics.library/FillPixelArray     cybergraphics.library/FillPixelArray
  392.  
  393.  
  394.    NAME
  395.         FillPixelArray -- fill a rectangular area with the supplied ARGB value
  396.     starting at a specified x,y location and continuing through to another
  397.     x,y location within a certain RastPort
  398.  
  399.    SYNOPSIS
  400.     count = FillPixelArray(RastPort,DestX, DestY,SizeX,SizeY,ARGB)
  401.     D0             A1     D0:16  D1:16 D2:16 D3:16 D4:32
  402.             
  403.  
  404.     LONG FillPixelArray(struct RastPort *,UWORD,UWORD,UWORD,UWORD,ULONG)
  405.  
  406.    FUNCTION
  407.     For each pixel in a rectangular region, write the supplied color value
  408.     into the bitmap used to describe a particular rastport.
  409.  
  410.    INPUTS
  411.     RastPort -  pointer to a RastPort structure
  412.     (DestX,DestY) - starting point in the RastPort
  413.     (SizeX,SizeY) - size of the rectangle that should be transfered
  414.         ARGB  - the desired color in AARRGGBB format. Every component
  415.         allocates 8 bits of the returned longword. The coding is as
  416.         follows:
  417.  
  418.                  AA - 8-bit alpha channel component
  419.               (set it to 00 if you do not use it !)
  420.                  RR - 8-bit red component of the pixel
  421.                  GG - 8-bit green component
  422.                  BB - 8-bit blue component
  423.  
  424.    RESULT
  425.     count will be set to the number of pixels plotted
  426.  
  427.    NOTES
  428.     This function should only be used on screens depths > 8 bits.
  429.  
  430.    BUGS
  431.     In the current release this function only works on screen rastports.
  432.     Because of this limitation clipping is not supported.
  433.  
  434.  
  435. cybergraphics.library/InvertPixelArray     cybergraphics.library/InvertPixelArray
  436.  
  437.  
  438.    NAME
  439.         InvertPixelArray -- invert a rectangular area tarting at a specified x,y
  440.     location and continuing through to another x,y location within a certain
  441.     RastPort
  442.  
  443.    SYNOPSIS
  444.     count = InvertPixelArray(RastPort,DestX, DestY,SizeX,SizeY)
  445.     D0               A1     D0:16  D1:16 D2:16 D3:16
  446.             
  447.  
  448.     LONG InvertPixelArray(struct RastPort *,UWORD,UWORD,UWORD,UWORD)
  449.  
  450.    FUNCTION
  451.     Invert each pixel in a rectangular region.
  452.  
  453.    INPUTS
  454.     RastPort -  pointer to a RastPort structure
  455.     (DestX,DestY) - starting point in the RastPort
  456.     (SizeX,SizeY) - size of the rectangle that should be transfered
  457.  
  458.    RESULT
  459.     count will be set to the number of pixels plotted
  460.  
  461.    NOTES
  462.     This function should only be used on screens depths > 8 bits.
  463.  
  464.    BUGS
  465.     In the current release this function only works on screen rastports.
  466.     Because of this limitation clipping is not supported.
  467.  
  468.  
  469. cybergraphics.library/MovePixelArray     cybergraphics.library/MovePixelArray
  470.  
  471.  
  472.    NAME
  473.         MovePixelArray -- move the color values of a rectangular area of
  474.     pixels starting at a specified x,y location and continuing through
  475.     to another x,y location within a certain RastPort
  476.  
  477.    SYNOPSIS
  478.     count = MovePixelArray(SrcX, SrcY, RastPort,SrcX , SrcY ,SizeX, SizeY)
  479.     D0               D0:16 D1:16  A1      D2:16  D3:16 D4:16  D5:16
  480.  
  481.     LONG MovePixelArray(UWORD,UWORD,struct RastPort *,UWORD,UWORD,UWORD,
  482.                 UWORD)
  483.  
  484.    FUNCTION
  485.     For each pixel in a rectangular region, move the pixel value from a
  486.     specified source to a specified destination
  487.  
  488.    INPUTS
  489.     (SrcX,SrcY) - starting point in the destination rectangle
  490.     RastPort -  pointer to a RastPort structure
  491.     (DestX,DestY) - starting point in the destination rectangle
  492.     (SizeX,SizeY) - size of the rectangle that should be transfered
  493.  
  494.    RESULT
  495.     count will be set to the number of pixels moved
  496.  
  497.    NOTES
  498.     This function should only be used on screens depths > 8 bits.
  499.     The blitter can be used to move the data if the bitmap is in display
  500.     memory. This is way you should use this call.
  501.  
  502.    BUGS
  503.     In the current release this function only works on screen rastports.
  504.     Because of that limitation clipping is not supported.
  505.  
  506. cybergraphics.library/ReadPixelArray     cybergraphics.library/ReadPixelArray
  507.  
  508.  
  509.    NAME
  510.         ReadPixelArray -- Read the color values of a rectangular array of
  511.     pixels starting at a specified x,y location and continuing through
  512.     to another x,y location within a certain RastPort
  513.  
  514.    SYNOPSIS
  515.     count = ReadPixelArray(destRect,DestX,DestY,DestMod,RastPort,SrcX ,
  516.     D0              A0    D0:16 D1:16 D2:16     A1     D3:16
  517.                 SrcY ,SizeX,SizeY,DestFormat)
  518.                 D4:16 D5:16 D6:16    D7
  519.  
  520.     LONG ReadPixelArray(APTR *,UWORD,UWORD,UWORD,struct RastPort *,UWORD,
  521.                 UWORD,UWORD,UWORD,UBYTE)
  522.  
  523.    FUNCTION
  524.     For each pixel in a rectangular region, write the color value to a
  525.     linear array of color values from the bitmap used to describe a
  526.     particular rastport.
  527.  
  528.    INPUTS
  529.     destRect - pointer to an array of pixels where to write the pixel
  530.                data to. The pixel format is specified in DestFormat
  531.     (DestX,DestY) - starting point in the destination rectangle
  532.     DestMod - The number of bytes per row in the destination rectangle.
  533.     RastPort -  pointer to a RastPort structure
  534.     (SrcX,SrcY) - starting point in the RastPort
  535.     (SizeX,SizeY) - size of the rectangle that should be transfered
  536.     DestFormat - pixel format in the destination rectangle
  537.                 Currently supported formats are:
  538.  
  539.                 RECTFMT_RGB  3 bytes per pixel, one byte red, one blue
  540.                              and one byte green component
  541.  
  542.                 RECTFMT_RGBA 4 bytes per pixel, one byte red, one blue,
  543.                              one byte green component and the last
  544.                                  byte is alpha channel information which
  545.                          is 0 if the board does not support alpha
  546.                                  channel
  547.  
  548.                 RECTFMT_ARGB 4 bytes per pixel, one byte red, one blue,
  549.                              one byte green component and the first
  550.                                  byte is alpha channel information. If the
  551.                                  board does not support alpha channel a 
  552.                          0 is returned for alpha channel information
  553.  
  554.    RESULT
  555.     count will be set to the number of pixels read
  556.  
  557.    NOTES
  558.     This function should only be used on screens depths > 8 bits.
  559.  
  560.    BUGS
  561.     In the current release this function only works on screen rastports.
  562.     Because of that limitation clipping is not supported.
  563.  
  564. cybergraphics.library/SwapPixelArray     cybergraphics.library/SwapPixelArray
  565.  
  566.  
  567.    NAME
  568.         SwapPixelArray -- Swap the color values of a rectangular array of
  569.     pixels starting at a specified x,y location and continuing through
  570.     to another x,y location within a certain RastPort
  571.  
  572.    SYNOPSIS
  573.     count = SwapPixelArray(MemRect,MemX  ,MemY,MemMod,RastPort, RastX ,
  574.     D0              A0   D0:16 D1:16 D2:16     A1     D3:16
  575.                 RastY ,SizeX,SizeY,MemFormat)
  576.                 D4:16 D5:16 D6:16    D7
  577.  
  578.     LONG SwapPixelArray(APTR *,UWORD,UWORD,UWORD,struct RastPort *,UWORD,
  579.                 UWORD,UWORD,UWORD,UBYTE)
  580.  
  581.    FUNCTION
  582.     For each pixel in a rectangular region, swap the color values of a
  583.     linear array of color values and a bitmap used to describe a
  584.     particular rastport.
  585.  
  586.    INPUTS
  587.     MemRect - pointer to an array of pixels where to write the pixel
  588.               data of the bitmapto. The pixel format is specified in
  589.           MemFormat
  590.     (MemX,MemY) - starting point in the memory rectangle
  591.     MemMod - The number of bytes per row in the memory rectangle.
  592.     RastPort -  pointer to a RastPort structure
  593.     (RastX,RastY) - starting point in the RastPort rectangle
  594.     (SizeX,SizeY) - size of the rectangle that should be transfered
  595.     MemFormat - pixel format in the memory rectangle
  596.                 Currently supported formats are:
  597.  
  598.                 RECTFMT_RGB  3 bytes per pixel, one byte red, one blue
  599.                              and one byte green component
  600.  
  601.                 RECTFMT_RGBA 4 bytes per pixel, one byte red, one blue,
  602.                              one byte green component and the last
  603.                                  byte is alpha channel information which
  604.                          is 0 if the board does not support alpha
  605.                                  channel
  606.  
  607.                 RECTFMT_ARGB 4 bytes per pixel, one byte red, one blue,
  608.                              one byte green component and the first
  609.                                  byte is alpha channel information. If the
  610.                                  board does not support alpha channel a 
  611.                          0 is returned for alpha channel information
  612.  
  613.    RESULT
  614.     count will be set to the number of pixels swapped
  615.  
  616.    NOTES
  617.     This function should only be used on screens depths > 8 bits.
  618.  
  619.    BUGS
  620.     In the current release this function only works on screen rastports.
  621.     Because of that limitation clipping is not supported.
  622.  
  623. cybergraphics.library/ReadRGBPixel          cybergraphics.library/ReadRGBPixel
  624.  
  625.  
  626.    NAME
  627.         ReadRGBPixel -- Reads a pixel from a specified location
  628.  
  629.    SYNOPSIS
  630.         color = ReadRGBPixel(RastPort,x ,y )
  631.         D0                     A0     D0 D1
  632.  
  633.         ULONG ReadRGBPixel(struct RastPort *,UWORD,UWORD);
  634.  
  635.    FUNCTION
  636.     Read the Alpha,Red,Green & Blue 8-bit color value of the pixel at a
  637.     specified x,y location within a certain RastPort
  638.  
  639.    INPUTS
  640.     rp -  pointer to a RastPort structure
  641.         x,y    - the coordinates of the pixel
  642.  
  643.    RESULT
  644.         color  - the desired color in AARRGGBB format. Every component
  645.          allocates 8 bits of the returned longword. The coding is as
  646.          follows:
  647.  
  648.                  AA - 8-bit alpha channel component
  649.               (boards which do not have an alpha channel return 00)
  650.                  RR - 8-bit red component of the pixel
  651.                  GG - 8-bit green component
  652.                  BB - 8-bit blue component
  653.  
  654.   NOTES
  655.     This function should only be used on screens depths > 8 bits. Use
  656.     ReadPixel() on 8 bit screens !
  657.  
  658.   BUGS
  659.     In the current release this function only works on screen rastports.
  660.     Because of that limitation clipping is not supported.
  661.  
  662. cybergraphics.library/WritePixelArray   cybergraphics.library/WritePixelArray
  663.  
  664.  
  665.    NAME
  666.         WritePixelArray -- write the color value of a rectangular array of
  667.     pixels starting at a specified x,y location and continuing through
  668.     to another x,y location within a certain RastPort
  669.  
  670.    SYNOPSIS
  671.     count = WritePixelArray(srcRect,SrcX ,SrcY ,SrcMod,RastPort,DestX,
  672.     D0               A0   D0:16 D1:16 D2:16     A1    D3:16
  673.                 DestY,SizeX,SizeY,SrcFormat)
  674.                 D4:16 D5:16 D6:16    D7
  675.  
  676.     LONG WritePixelArray(APTR *,UWORD,UWORD,UWORD,struct RastPort *,UWORD,
  677.                  UWORD,UWORD,UWORD,UBYTE)
  678.  
  679.    FUNCTION
  680.     For each pixel in a rectangular region, write the color value from a
  681.     linear array of color values into the bitmap used to describe a
  682.     particular rastport.
  683.  
  684.    INPUTS
  685.     srcRect - pointer to an array of pixels from which to fetch the
  686.               pixel data. The pixel format is specified in SrcFormat
  687.     (SrcX,SrcY) - starting point in the source rectangle
  688.     SrcMod - The number of bytes per row in the source rectangle.
  689.     RastPort -  pointer to a RastPort structure
  690.     (DestX,DestY) - starting point in the RastPort
  691.     (SizeX,SizeY) - size of the rectangle that should be transfered
  692.     SrcFormat - pixel format in the source rectangle
  693.                 Currently supported formats are:
  694.  
  695.                 RECTFMT_RGB  3 bytes per pixel, one byte red, one blue
  696.                              and one byte green component
  697.  
  698.                 RECTFMT_RGBA 4 bytes per pixel, one byte red, one blue,
  699.                              one byte green component and the last
  700.                                  byte is alpha channel information. If you
  701.                                  do not use alpha channel set this byte to
  702.                          0 !!!
  703.  
  704.                 RECTFMT_ARGB 4 bytes per pixel, one byte red, one blue,
  705.                              one byte green component and the first
  706.                                  byte is alpha channel information. If you
  707.                                  do not use alpha channel set this byte to
  708.                          0 !!!
  709.  
  710.    RESULT
  711.     count will be set to the number of pixels plotted
  712.  
  713.    NOTES
  714.     This function should only be used on screens depths > 8 bits. Use
  715.     WritePixelArray8() on 8 bit screens !
  716.  
  717.    BUGS
  718.     In the current release this function only works on screen rastports.
  719.     Because of that limitation clipping is not supported.
  720.  
  721.  
  722. cybergraphics.library/WriteRGBPixel        cybergraphics.library/WriteRGBPixel
  723.  
  724.  
  725.    NAME
  726.         WriteRGBPixel -- Writes a pixel to a specified location
  727.  
  728.    SYNOPSIS
  729.         error = WriteRGBPixel(RastPort,x ,y ,color)
  730.         D0                      A0     D0 D1 d2
  731.  
  732.         ULONG WriteRGBPixel(struct RastPort *,UWORD,UWORD,ULONG);
  733.  
  734.    FUNCTION
  735.     Write the Alpha,Red,Green & Blue 8-bit color value of the given color
  736.     to a specified x,y location within a certain RastPort
  737.  
  738.    INPUTS
  739.     rp     - pointer to a RastPort structure
  740.         x,y    - the coordinates of the pixel
  741.         color  - the desired color in AARRGGBB format. Every component
  742.          allocates 8 bits of the returned longword. The coding is as
  743.          follows:
  744.  
  745.                  AA - 8-bit alpha channel component
  746.               (set it to 00 if you dont want to use it !)
  747.                  RR - 8-bit red component of the pixel
  748.                  GG - 8-bit green component
  749.                  BB - 8-bit blue component
  750.  
  751.    RESULT
  752.     error = 0 if pixel succesfully changed
  753.           = -1 if (x,y) is outside the rastport
  754.  
  755.    NOTES
  756.     This function should only be used on screens depths > 8 bits. Use
  757.     WritePixel() on 8 bit screens !
  758.  
  759.    BUGS
  760.     In the current release this function only works on screen rastports.
  761.     Because of that limitation clipping is not supported.
  762.  
  763.